add `Using with CMake` instructions
authorKevin Albertson <kevin.eric.albertson@gmail.com>
Mon, 15 Jan 2024 15:03:18 +0000 (10:03 -0500)
committerKevin Albertson <kevin.eric.albertson@gmail.com>
Mon, 15 Jan 2024 15:52:59 +0000 (10:52 -0500)
README.md

index 2923e8cde2f22800c5103e559e83f8ff6798b574..14b33301ae3be843cc443080716d4d05321a4d2a 100644 (file)
--- a/README.md
+++ b/README.md
@@ -42,6 +42,16 @@ cmake -S . -B build
 cmake --build build
 ```
 
+## Using with CMake
+
+A CMake Config-file package is provided. To use utf8proc in a CMake project:
+
+```cmake
+add_executable (app app.c)
+find_package (utf8proc 2.9.0 REQUIRED)
+target_link_libraries (app PRIVATE utf8proc::utf8proc)
+```
+
 ### Using other compilers
 The included `Makefile` supports GNU/Linux flavors and MacOS with `gcc`-like compilers; Windows users will typically use `cmake`.